home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / mhp32sw / howtorun.tx_ / howtorun.tx
Encoding:
Text File  |  1994-09-14  |  7.4 KB  |  184 lines
  1.  
  2.               ** A BRIEF OVERVIEW OF **
  3.     ** HOW TO RUN MINIHELP PLUS V3.2 **
  4.  
  5.  
  6. For a complete explanation of how to run MiniHelp Plus v3.2,
  7. consult the User's Manual and the online Help files,
  8. mhplus32.hlp and mhpshell.hlp.
  9.  
  10.  
  11. MiniHelp Plus v3.2 adds more functionality and ease of use
  12. to the "button bar" Windows shell that was introduced with
  13. the release of MiniHelp Plus v3.1.  Quite simply, if you can
  14. a) type, and b) click the mouse on a button, you are fully
  15. capable of writing your very own Windows Help Files.  And
  16. you can learn to do so in a very, very short time since the
  17. commands for MiniHelp Plus v3.2 are uncomplicated, easy
  18. to use, easy to learn, and fast.
  19.  
  20.  
  21. Below is a list of the buttons and some of the features of
  22. MiniHelp Plus v3.2.  The program has grown IMMENSELY
  23. since MiniHelp Plus v1.0, and quite a few of the features
  24. are new to MiniHelp Plus v3.2.
  25.  
  26.  
  27. ** COMPILE RTF **
  28. After you have typed in (and saved) your MiniHelp Plus v3.2
  29. source file, click on this button to create the RTF File, Help
  30. Project File (HPJ), Header File (HHH), and the bitmapped
  31. image INI file (mhp23bmp.dat).
  32.  
  33.  
  34. ** HELP COMPILER **
  35. Clicking on this button causes the Microsoft Help Compiler
  36. to begin compiling your Help file, using the HPJ file generated
  37. by MiniHelp Plus v3.2.
  38.  
  39.  
  40. ** MINIHELP HELP **
  41. The MiniHelp Plus v3.2 Help file is displayed when you click
  42. on this button on the button bar.  The information in this Help
  43. file will assist you with learning (and serve as a reference to)
  44. the commands of MiniHelp Plus v3.2 and tell you everything
  45. you need to know to create your first Help file using MiniHelp
  46. Plus v3.2.  It will also guide you through the syntax used to
  47. create your MiniHelp Plus v3.2 source file.
  48.  
  49.  
  50. ** CONFIGURE... **
  51. Clicking on this button brings up the dialog box where you
  52. configure MiniHelp Plus v3.2.  It is here where you define
  53. such things as the name of your current source file, the path
  54. and filename of your default ASCII text editor and which version
  55. of the Help Compiler you are using.  You can also select a
  56. few options which tell MiniHelp Plus v3.2 whether to load
  57. in the source file of the currently defined project when you
  58. launch your default text editor, whether to load the HHH, HPJ,
  59. and ERR files into your default text editor or Windows Notepad,
  60. and whether to display the Welcome/Reminder message box
  61. each time MiniHelp Plus v3.2 is started.
  62.  
  63.  
  64. ** VIEW RTF FILE **
  65. You can view the RTF file generated by MiniHelp Plus v3.2
  66. by clicking on this button.  The RTF file is loaded into Windows
  67. Write word processor for you to view/edit.  And MiniHelp Plus
  68. v3.2 also automatically takes care of clearing away the annoying
  69. "Convert, No Conversion, Cancel" message box that ALWAYS
  70. appears whenever you load Windows Write with a file not in
  71. the Write format.
  72.  
  73.  
  74. ** VIEW HPJ FILE **
  75. To view/edit the HPJ file generated by MiniHelp Plus v3.2,
  76. click on this button.
  77.  
  78.  
  79. ** ABOUT... **
  80. Clicking on this button displays the usual "ego" screen, telling
  81. you about MiniHelp Plus v3.2.
  82.  
  83.  
  84. ** TEXT EDITOR **
  85. To launch your default ASCII text editor, click on this button.
  86. Depending on how you have MiniHelp Plus v3.2 configured,
  87. either the text editor itself will load up ready for a new file
  88. from scratch, or pre-loaded with the currently configured
  89. MiniHelp Plus v3.2 source file.
  90.  
  91.  
  92. ** ERROR FILE **
  93. You can view the error file (ERR) output by the Help Compiler
  94. at your leisure by clicking on this button.  Depending on
  95. how you have MiniHelp Plus v3.2 configured, the ERR file 
  96. will open, pre-loaded into either your default text editor or
  97. Windows Notepad.  This file displays the errors encountered
  98. by the Help Compiler while buiding (compiling) your Help file.
  99.  
  100.  
  101. ** TOOLPAD HELP **
  102. Viewing the MiniHelp Plus v3.2 Help file that tells you how to
  103. run/operate the MiniHelp Plus v3.2 Windows interface is as
  104. easy as clicking on this button.  The graphics in the file are
  105. defined as "hypergraphics," meaning click on the button or 
  106. item of the MiniHelp Plus v3.2 window you want information
  107. on and a definition of what that button does pops up on the
  108. screen.
  109.  
  110.  
  111. ** VIEW HELP **
  112. Your new-just-been-completed Help file can be viewed simply
  113. by clicking on this button.  Of course, if a serious error was
  114. encountered by the Help Compiler during the build, your Help
  115. file might not exist yet (even though you might think it does).
  116. For this reason, it is a GOOD idea to check your Error File
  117. right after compiling your Help file.  This way, if no Help file
  118. appears, you have a good idea of why.
  119.  
  120.  
  121. ** VIEW HEADER **
  122. There will be times when you will need to access the Header
  123. file generated by MiniHelp Plus v3.2.  When you do, simply
  124. click on this button and, depending on how you have MiniHelp
  125. Plus v3.2 configured, the Header file will be loaded into either
  126. your default text editor or Windows Notepad.  Why might you
  127. want to view it?  Some of the Help macros can only be invoked
  128. if you know the context-id of a topic.  That is what this file
  129. contains.  MiniHelp Plus v3.2 creates it when you compile the
  130. source file and lists the topics in your source file, assigning
  131. a unique number to each one (the context-id number).
  132.  
  133.  
  134. ** VIEW BITMAPS **
  135. If you have PROPERLY defined the bitmaps in your Help project
  136. by including them in your HPJ file with the .hpjbitmap command,
  137. clicking this button will display a dialog box listing all the valid
  138. bitmaps defined in your project.  From there, you either double-
  139. click on the filename you want to view or click once on the name
  140. of the file you want to view and click on the view button.  The
  141. selected file will be displayed for you to view/edit, preloaded
  142. into Windows Paintbrush.  (NOTE:  Only those files with the
  143. file extension of .BMP are listed, since at this time, only Windows
  144. Paintbrush is used to view the bitmapped image files.  Perhaps
  145. I will allow users to configure future versions of MiniHelp Plus
  146. to use the Paint editor of their choice, much like the way users
  147. can define the default text editor of their choice now.  But, for
  148. the time being, only the .BMP file format is supported so you
  149. will need to convert any image files to this format if you want
  150. to be able to use this feature.  I am also toying with the idea
  151. of allowing users who have a copy of SHED.EXE, Microsoft's
  152. Hot Spot Editor, to load those files into that program in a
  153. future release.)
  154.  
  155.  
  156. ** EXIT **
  157. Clicking on this button allows you to quit MiniHelp Plus v3.2.
  158. Just in case you pressed it by mistake, you are asked if you
  159. are sure you want to quit.  Click on YES if you do, and NO if
  160. you do not want to quit at this time.
  161.  
  162.  
  163. ** OTHER FEATURES **
  164.  
  165. ** STATUS BAR **
  166. MiniHelp Plus v3.2 now sports a status bar that tells you what
  167. your last action was in MiniHelp Plus v3.2.
  168.  
  169. ** ALWAYS ON TOP **
  170. Now, you can toggle whether MiniHelp Plus v3.2 is the topmost
  171. window on your screen by selecting this option from the system
  172. menu.  Default is on.  When it is on, the far right side of the
  173. status bar has the words "ON TOP" displayed.  If it is not on,
  174. nothing is displayed in this part of the status bar.
  175.  
  176. ** TITLE BAR **
  177. The title bar of the MiniHelp Plus v3.2 window now displays the
  178. name of the currently defined project to serve as a visual and
  179. constant reminder of the currently configured project.
  180.  
  181.  
  182. As I stated before, for complete information on running MiniHelp
  183. Plus v3.2, consult the User's Manual and the online Help files.
  184.